<meta charset="utf-8">
(#) Use Mipmap Launcher Icons

!!! WARNING: Use Mipmap Launcher Icons
   This is a warning.

Id
:   `MipmapIcons`
Summary
:   Use Mipmap Launcher Icons
Severity
:   Warning
Category
:   Usability: Icons
Platform
:   Android
Vendor
:   Android Open Source Project
Feedback
:   https://issuetracker.google.com/issues/new?component=192708
Since
:   1.1.0 (February 2015)
Affects
:   Manifest files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/ManifestDetector.kt)
Tests
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/ManifestDetectorTest.kt)

Launcher icons should be provided in the `mipmap` resource directory.
This is the same as the `drawable` resource directory, except resources
in the `mipmap` directory will not get stripped out when creating
density-specific APKs.

In certain cases, the Launcher app may use a higher resolution asset
(than would normally be computed for the device) to display large app
shortcuts. If drawables for densities other than the device's resolution
have been stripped out, then the app shortcut could appear blurry.

To fix this, move your launcher icons from `drawable-`dpi to
`mipmap-`dpi and change references from @drawable/ and R.drawable to
@mipmap/ and R.mipmap.

In Android Studio this lint warning has a quickfix to perform this
automatically.

!!! Tip
   This lint check has an associated quickfix available in the IDE.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/main/AndroidManifest.xml:8:Warning: Should use @mipmap instead of
@drawable for launcher icons [MipmapIcons]
    android:icon="@drawable/ic_launcher"
    ------------------------------------
src/main/AndroidManifest.xml:13:Warning: Should use @mipmap instead of
@drawable for launcher icons [MipmapIcons]
    android:icon="@drawable/activity1"
    ----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here are the relevant source files:

`src/main/AndroidManifest.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="test.mipmap"
    android:versionCode="1"
    android:versionName="1.0" &gt;

    &lt;!-- Wrong icon resource type --&gt;
    &lt;application
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name" &gt;
        &lt;!-- Wrong icon resource type --&gt;
        &lt;activity
            android:name=".Activity1"
            android:icon="@drawable/activity1"
            android:label="@string/activity1" &gt;
            &lt;intent-filter&gt;
                &lt;action android:name="android.intent.action.MAIN" /&gt;
                &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
            &lt;/intent-filter&gt;
        &lt;/activity&gt;
        &lt;!-- Already a @mipmap resource --&gt;
        &lt;activity
            android:name=".Activity2"
            android:icon="@mipmap/activity2"
            android:label="@string/activity2" &gt;
        &lt;/activity&gt;
        &lt;!-- Not a launchable activity --&gt;
        &lt;activity
            android:name=".Activity3"
            android:icon="@drawable/activity3"
            android:label="@string/activity3" &gt;
        &lt;/activity&gt;
    &lt;/application&gt;

&lt;/manifest&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`build.gradle`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~groovy linenumbers
android {
    defaultConfig {
        resConfigs "cs"
    }
    flavorDimensions  "pricing", "releaseType"
    productFlavors {
        beta {
            dimension "releaseType"
            resConfig "en", "de"
            resConfigs "nodpi", "hdpi"
        }
        normal { dimension "releaseType" }
        free { dimension "pricing" }
        paid { dimension "pricing" }
    }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/ManifestDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `ManifestDetector.testMipMapWithDensityFiltering`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=192708.

(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Adding the suppression attribute `tools:ignore="MipmapIcons"` on the
  problematic XML element (or one of its enclosing elements). You may
  also need to add the following namespace declaration on the root
  element in the XML file if it's not already there:
  `xmlns:tools="http://schemas.android.com/tools"`.

  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;manifest xmlns:tools="http://schemas.android.com/tools"&gt;
      ...
      &lt;application tools:ignore="MipmapIcons" .../&gt;
    ...
  &lt;/manifest&gt;
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="MipmapIcons" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'MipmapIcons'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore MipmapIcons ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>